<meta charset="utf-8">
(#) ModifierNodeElement missing inspectableProperties

!!! Tip: ModifierNodeElement missing inspectableProperties
   Advice from this check is just a hint; it's "weak" warning.

Id
:   `ModifierNodeInspectableProperties`
Summary
:   ModifierNodeElement missing inspectableProperties
Severity
:   Hint
Category
:   Productivity
Platform
:   Any
Vendor
:   Jetpack Compose
Identifier
:   androidx.compose.ui
Feedback
:   https://issuetracker.google.com/issues/new?component=612128
Min
:   Lint 8.0 and 8.1
Compiled
:   Lint 8.0 and 8.1
Artifact
:   [androidx.compose.ui:ui-android](androidx_compose_ui_ui-android.md.html)
Since
:   1.5.0
Affects
:   Kotlin and Java files
Editing
:   This check runs on the fly in the IDE editor
Implementation
:   [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/compose/ui/ui-lint/src/main/java/androidx/compose/ui/lint/ModifierNodeInspectablePropertiesDetector.kt)
Tests
:   [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/compose/ui/ui-lint/src/test/java/androidx/compose/ui/lint/ModifierNodeInspectablePropertiesDetectorTest.kt)
Copyright Year
:   2023

ModifierNodeElements may override inspectableProperties() to provide
information about the modifier in the layout inspector. The default
implementation attempts to read all of the properties on the class
reflectively, which may not comprehensively or effectively describe the
modifier.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
src/test/Element.kt:8:Information: Element does not override
inspectableProperties(). The layout inspector will use the default
implementation of this function, which will attempt to read Element's
properties reflectively. Override inspectableProperties() if you'd like
to customize this modifier's presentation in the layout inspector.
[ModifierNodeInspectableProperties]
    class Element : ModifierNodeElement&lt;Modifier.Node&gt;() {
          -------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here is the source file referenced above:

`src/test/Element.kt`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers
package test

import androidx.compose.ui.Modifier
import androidx.compose.ui.platform.InspectableValue
import androidx.compose.ui.node.ModifierNodeElement

class Element : ModifierNodeElement<Modifier.Node>() {
    override fun create() = object : Modifier.Node() {}
    override fun update(node: Modifier.Node) = node
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/compose/ui/ui-lint/src/test/java/androidx/compose/ui/lint/ModifierNodeInspectablePropertiesDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

The above example was automatically extracted from the first unit test
found for this lint check, `ModifierNodeInspectablePropertiesDetector.testNodeElementWithNoInspectableValues_flagsError`.
To report a problem with this extracted sample, visit
https://issuetracker.google.com/issues/new?component=612128.

(##) Including

!!!
   This is not a built-in check. To include it, add the below dependency
   to your project.

```
// build.gradle.kts
implementation("androidx.compose.ui:ui-android:1.8.0-alpha07")

// build.gradle
implementation 'androidx.compose.ui:ui-android:1.8.0-alpha07'

// build.gradle.kts with version catalogs:
implementation(libs.ui.android)

# libs.versions.toml
[versions]
ui-android = "1.8.0-alpha07"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
ui-android = {
    module = "androidx.compose.ui:ui-android",
    version.ref = "ui-android"
}
```

1.8.0-alpha07 is the version this documentation was generated from;
there may be newer versions available.

NOTE: These lint checks are **also** made available separate from the main library.
You can also use `androidx.compose.ui:ui-lint:1.8.0-alpha07`.


[Additional details about androidx.compose.ui:ui-android](androidx_compose_ui_ui-android.md.html).
(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Using a suppression annotation like this on the enclosing
  element:

  ```kt
  // Kotlin
  @Suppress("ModifierNodeInspectableProperties")
  fun method() {
     problematicStatement()
  }
  ```

  or

  ```java
  // Java
  @SuppressWarnings("ModifierNodeInspectableProperties")
  void method() {
     problematicStatement();
  }
  ```

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection ModifierNodeInspectableProperties
  problematicStatement()
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="ModifierNodeInspectableProperties" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'ModifierNodeInspectableProperties'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore ModifierNodeInspectableProperties ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>